/*
**************************************************************************************
*Myriad Engine                                                                       *
*Copyright (C) 2006-2007, 5d Studios (www.5d-Studios.com)                            *
*                                                                                    *
*This library is free software; you can redistribute it and/or                       *
*modify it under the terms of the GNU Lesser General Public                          *
*License as published by the Free Software Foundation; either                        *
*version 2.1 of the License, or (at your option) any later version.                  *
*                                                                                    *
*This library is distributed in the hope that it will be useful,                     *
*but WITHOUT ANY WARRANTY; without even the implied warranty of                      *
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU                   *
*Lesser General Public License for more details.                                     *
*                                                                                    *
*You should have received a copy of the GNU Lesser General Public                    *
*License along with this library; if not, write to the Free Software                 *
*Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA      *
**************************************************************************************
*/
package leola.backend.interpreter;

import leola.backend.interpreter.StackFrame.ControlFlowType;

/**
 * Handles the state for BREAK and RETURN statements
 * 
 * @author Tony
 *
 */
public class StatementControl {

	/**
	 * Type
	 */
	private ControlFlowType type;
	
	/**
	 */
	public StatementControl() {
		clearState();
	}
	
	/**
	 * @param type the type to set
	 */
	public void setType(ControlFlowType type) {
		this.type = type;
	}
	
	/**
	 * @return the type
	 */
	public ControlFlowType getType() {
		return type;
	}
	
	/**
	 * @return true if BREAK or RETURN
	 */
	public boolean stopFlow() {
		return this.type.equals(ControlFlowType.BREAK) ||
			   this.type.equals(ControlFlowType.CONTINUE) ||
			   this.type.equals(ControlFlowType.RETURN);
	}
	
	/**
	 * Clears the control flow state
	 */
	public void clearState() {
		this.type = ControlFlowType.NONE;
	}
}
